<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>vprocss: xvprocss.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">vprocss
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xvprocss_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">xvprocss.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This is main code of Xilinx Video Processing Subsystem device driver. </p>
<p>Please see <a class="el" href="xvprocss_8h.html" title="This is main header file of the Xilinx Video Processing Subsystem driver. ">xvprocss.h</a> for more details of the driver.</p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who    Date     Changes
<hr/>

1.00  rco  08/28/15   Initial Release
2.00  rco  11/05/15   Update to adapt to sub-core layer 2 changes
      dmc  12/02/15   Added support for additional topologies
      dmc  12/17/15   Rename and modify H,VCresample constants and routines
                      Modify CSC-only validate and setup routines
                      Modify Scaler-only validate and setup routines
                      Modifications to conform to coding style
      dmc  01/11/16   Write to new Event Log: log status and error events
      dmc  02/17/16   Modify timing and placement of axis and aximm resets
      dmc  02/24/16   Rename some constants and variables
      dmc  03/03/16   Init VideoStream structs to 0 in SetPowerOnDefaultState
2.10  mpe  04/28/16   Added optional color format conversion handling in
                      scaler only topology
      rco  07/20/16   Replace deprecated MB_Sleep with usleep
                      Maintain user defined PIP color between pipe reset
2.30  rco  12/15/16   Added HasMADI configuration option check
           02/08/17   Fix C++ compilation warnings
           02/15/17   Fix custom resolution support for 1 PPC configuration</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Reset Network</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>The following constants define various reset lines in the subsystem </p>
</div></td></tr>
<tr class="memitem:a222fde5e6896742abd771d50c488118b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a222fde5e6896742abd771d50c488118b">XVPROCSS_RSTMASK_VIDEO_IN</a>&#160;&#160;&#160;(0x01)</td></tr>
<tr class="memdesc:a222fde5e6896742abd771d50c488118b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset line going out of vpss.  <a href="#a222fde5e6896742abd771d50c488118b">More...</a><br /></td></tr>
<tr class="separator:a222fde5e6896742abd771d50c488118b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af87c7ccc12aec9201a98d39d7e186a2d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#af87c7ccc12aec9201a98d39d7e186a2d">XVPROCSS_RSTMASK_IP_AXIS</a>&#160;&#160;&#160;(0x02)</td></tr>
<tr class="memdesc:af87c7ccc12aec9201a98d39d7e186a2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset line for vpss internal video IP blocks.  <a href="#af87c7ccc12aec9201a98d39d7e186a2d">More...</a><br /></td></tr>
<tr class="separator:af87c7ccc12aec9201a98d39d7e186a2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fb66632e7266e1abf4292b8ec819b50"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a4fb66632e7266e1abf4292b8ec819b50">XVPROCSS_RSTMASK_IP_AXIMM</a>&#160;&#160;&#160;(0x01)</td></tr>
<tr class="memdesc:a4fb66632e7266e1abf4292b8ec819b50"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset line for vpss internal AXI-MM blocks.  <a href="#a4fb66632e7266e1abf4292b8ec819b50">More...</a><br /></td></tr>
<tr class="separator:a4fb66632e7266e1abf4292b8ec819b50"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
VDMA Alignment required step size</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrp19fe26b8914c6f08adb6d6e20f434ae6"></a>The following constants define various Zoom/Pip window horizontal step sizes that keeps the VDMA access aligned to aximm interface width, based on Pixels/Clock and Color Depth of the configured subsystem.</p>
<p>This is required as current version of VDMA does not support DRE if interface width is &gt;64bits. Software has to align the hsize and stride for all possible configurations supported by the subsystem. Current subsystem version supports the following</p><ul>
<li>Number of components = 3 (Fixed)</li>
<li>Pixels/Clock = 1, 2, 4</li>
<li>Color Depth = 8, 10, 12, 16 (4 variations) </li>
</ul>
</td></tr>
<tr class="memitem:ad8037f2e08fc24847ac88a924d16a9f8"><td class="memItemLeft" align="right" valign="top"><a id="ad8037f2e08fc24847ac88a924d16a9f8"></a>
const u16&#160;</td><td class="memItemRight" valign="bottom"><b>XVprocSs_PixelHStep</b> [3][4]</td></tr>
<tr class="separator:ad8037f2e08fc24847ac88a924d16a9f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add7069c7a21fe0cf07779dcb945cab96"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#add7069c7a21fe0cf07779dcb945cab96">XVprocSs_SetUserTimerHandler</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, XVidC_DelayHandler CallbackFunc, void *CallbackRef)</td></tr>
<tr class="memdesc:add7069c7a21fe0cf07779dcb945cab96"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function registers the user defined delay/sleep function with subsystem.  <a href="#add7069c7a21fe0cf07779dcb945cab96">More...</a><br /></td></tr>
<tr class="separator:add7069c7a21fe0cf07779dcb945cab96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a650457b5f1b57842c2e3edd06d1de480"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a650457b5f1b57842c2e3edd06d1de480">XVprocSs_SetFrameBufBaseaddr</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, UINTPTR addr)</td></tr>
<tr class="memdesc:a650457b5f1b57842c2e3edd06d1de480"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the base address of the video frame buffers used by the subsystem instance.  <a href="#a650457b5f1b57842c2e3edd06d1de480">More...</a><br /></td></tr>
<tr class="separator:a650457b5f1b57842c2e3edd06d1de480"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac138624e6b5449040be8bd02710a512"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#aac138624e6b5449040be8bd02710a512">XVprocSs_CfgInitialize</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, <a class="el" href="struct_x_vproc_ss___config.html">XVprocSs_Config</a> *CfgPtr, UINTPTR EffectiveAddr)</td></tr>
<tr class="memdesc:aac138624e6b5449040be8bd02710a512"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes the video subsystem and included sub-cores.  <a href="#aac138624e6b5449040be8bd02710a512">More...</a><br /></td></tr>
<tr class="separator:aac138624e6b5449040be8bd02710a512"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f673d448bb7702661b702519de94fd9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a0f673d448bb7702661b702519de94fd9">XVprocSs_Start</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:a0f673d448bb7702661b702519de94fd9"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function starts the video subsystem including all sub-cores that are included in the processing pipeline for a given use-case.  <a href="#a0f673d448bb7702661b702519de94fd9">More...</a><br /></td></tr>
<tr class="separator:a0f673d448bb7702661b702519de94fd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f28821282af5defa07408d1c00c2bfe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a1f28821282af5defa07408d1c00c2bfe">XVprocSs_Stop</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:a1f28821282af5defa07408d1c00c2bfe"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function stops the video subsystem including all sub-cores Stop the video pipe starting from front to back.  <a href="#a1f28821282af5defa07408d1c00c2bfe">More...</a><br /></td></tr>
<tr class="separator:a1f28821282af5defa07408d1c00c2bfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab65fda7ce63456d82274a463a4d4b72a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#ab65fda7ce63456d82274a463a4d4b72a">XVprocSs_Reset</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:ab65fda7ce63456d82274a463a4d4b72a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function resets the video subsystem sub-cores.  <a href="#ab65fda7ce63456d82274a463a4d4b72a">More...</a><br /></td></tr>
<tr class="separator:ab65fda7ce63456d82274a463a4d4b72a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47c310a89b7072313404485d4bb9b03f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a47c310a89b7072313404485d4bb9b03f">XVprocSs_SetVidStreamIn</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, const XVidC_VideoStream *StrmIn)</td></tr>
<tr class="memdesc:a47c310a89b7072313404485d4bb9b03f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function configures the video subsystem input interface.  <a href="#a47c310a89b7072313404485d4bb9b03f">More...</a><br /></td></tr>
<tr class="separator:a47c310a89b7072313404485d4bb9b03f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28fae690c023b4d8b7a1d9b9c68c966c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a28fae690c023b4d8b7a1d9b9c68c966c">XVprocSs_SetVidStreamOut</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, const XVidC_VideoStream *StrmOut)</td></tr>
<tr class="memdesc:a28fae690c023b4d8b7a1d9b9c68c966c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function configures the video subsystem output interface.  <a href="#a28fae690c023b4d8b7a1d9b9c68c966c">More...</a><br /></td></tr>
<tr class="separator:a28fae690c023b4d8b7a1d9b9c68c966c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02c12d52974b723d6f5bb6d7fa0aa754"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a02c12d52974b723d6f5bb6d7fa0aa754">XVprocSs_SetStreamResolution</a> (XVidC_VideoStream *StreamPtr, const XVidC_VideoMode VmId, XVidC_VideoTiming const *Timing)</td></tr>
<tr class="memdesc:a02c12d52974b723d6f5bb6d7fa0aa754"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the required subsystem video stream to the user provided stream and timing parameters.  <a href="#a02c12d52974b723d6f5bb6d7fa0aa754">More...</a><br /></td></tr>
<tr class="separator:a02c12d52974b723d6f5bb6d7fa0aa754"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bdc6a00278cb1c847429d7498f8505e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a4bdc6a00278cb1c847429d7498f8505e">XVprocSs_UpdateZoomPipWindow</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:a4bdc6a00278cb1c847429d7498f8505e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function updates the Pip/Zoom window currently on screen in-place.  <a href="#a4bdc6a00278cb1c847429d7498f8505e">More...</a><br /></td></tr>
<tr class="separator:a4bdc6a00278cb1c847429d7498f8505e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8293d3dc637bc8c481b205d2272b4fc2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a8293d3dc637bc8c481b205d2272b4fc2">XVprocSs_SetZoomPipWindow</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, <a class="el" href="xvprocss_8h.html#a0743bfb208145c415f5af1ba231245a6">XVprocSs_Win</a> mode, XVidC_VideoWindow *win)</td></tr>
<tr class="memdesc:a8293d3dc637bc8c481b205d2272b4fc2"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function allows user to set the Zoom or PIP window.  <a href="#a8293d3dc637bc8c481b205d2272b4fc2">More...</a><br /></td></tr>
<tr class="separator:a8293d3dc637bc8c481b205d2272b4fc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55d0807b3f476d2608a8c49b44388fec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a55d0807b3f476d2608a8c49b44388fec">XVprocSs_GetZoomPipWindow</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, <a class="el" href="xvprocss_8h.html#a0743bfb208145c415f5af1ba231245a6">XVprocSs_Win</a> mode, XVidC_VideoWindow *win)</td></tr>
<tr class="memdesc:a55d0807b3f476d2608a8c49b44388fec"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reads the user defined Zoom/Pip window from scratch pad memory.  <a href="#a55d0807b3f476d2608a8c49b44388fec">More...</a><br /></td></tr>
<tr class="separator:a55d0807b3f476d2608a8c49b44388fec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a799db27e282d2762ee5cf4be40e70712"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a799db27e282d2762ee5cf4be40e70712">XVprocSs_SetZoomMode</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, u8 OnOff)</td></tr>
<tr class="memdesc:a799db27e282d2762ee5cf4be40e70712"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function configures the video subsystem to enable/disable ZOOM feature If ZOOM mode is set to ON but user has not set window coordinates then quarter of input stream resolution at coordinates 0,0 is set as the default zoom window.  <a href="#a799db27e282d2762ee5cf4be40e70712">More...</a><br /></td></tr>
<tr class="separator:a799db27e282d2762ee5cf4be40e70712"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84b1254cbeac02b7f81b1b90c721e84d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a84b1254cbeac02b7f81b1b90c721e84d">XVprocSs_SetPipMode</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, u8 OnOff)</td></tr>
<tr class="memdesc:a84b1254cbeac02b7f81b1b90c721e84d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function configures the video subsystem to enable/disable PIP feature If PIP mode is set to ON but user has not set window coordinates then half of input stream resolution at coordinates 0,0 is set as the default zoom window.  <a href="#a84b1254cbeac02b7f81b1b90c721e84d">More...</a><br /></td></tr>
<tr class="separator:a84b1254cbeac02b7f81b1b90c721e84d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49bdfcfcf9abb02829a7baf6603151f2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a49bdfcfcf9abb02829a7baf6603151f2">XVprocSs_SetSubsystemConfig</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:a49bdfcfcf9abb02829a7baf6603151f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is the entry point into the video processing subsystem driver processing path.  <a href="#a49bdfcfcf9abb02829a7baf6603151f2">More...</a><br /></td></tr>
<tr class="separator:a49bdfcfcf9abb02829a7baf6603151f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84c2f382ff78d4cc1c42628d0821870c"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a84c2f382ff78d4cc1c42628d0821870c">XVprocSs_GetPictureBrightness</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:a84c2f382ff78d4cc1c42628d0821870c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns picture brighntess setting.  <a href="#a84c2f382ff78d4cc1c42628d0821870c">More...</a><br /></td></tr>
<tr class="separator:a84c2f382ff78d4cc1c42628d0821870c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a186ce7049ca9f0bcaf1a5e76866fbf31"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a186ce7049ca9f0bcaf1a5e76866fbf31">XVprocSs_SetPictureBrightness</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, s32 NewValue)</td></tr>
<tr class="memdesc:a186ce7049ca9f0bcaf1a5e76866fbf31"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function updates picture brighntess setting with specified value.  <a href="#a186ce7049ca9f0bcaf1a5e76866fbf31">More...</a><br /></td></tr>
<tr class="separator:a186ce7049ca9f0bcaf1a5e76866fbf31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a628456c68064dcf093ecd1f7097e2879"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a628456c68064dcf093ecd1f7097e2879">XVprocSs_GetPictureContrast</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:a628456c68064dcf093ecd1f7097e2879"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns picture contrast setting.  <a href="#a628456c68064dcf093ecd1f7097e2879">More...</a><br /></td></tr>
<tr class="separator:a628456c68064dcf093ecd1f7097e2879"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65dcb2906de961ca823262f6b6039b87"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a65dcb2906de961ca823262f6b6039b87">XVprocSs_SetPictureContrast</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, s32 NewValue)</td></tr>
<tr class="memdesc:a65dcb2906de961ca823262f6b6039b87"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function updates picture contrast setting with specified value.  <a href="#a65dcb2906de961ca823262f6b6039b87">More...</a><br /></td></tr>
<tr class="separator:a65dcb2906de961ca823262f6b6039b87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a124ab620c7b3aa805ea8b0086ba0c344"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a124ab620c7b3aa805ea8b0086ba0c344">XVprocSs_GetPictureSaturation</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:a124ab620c7b3aa805ea8b0086ba0c344"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns picture saturation setting.  <a href="#a124ab620c7b3aa805ea8b0086ba0c344">More...</a><br /></td></tr>
<tr class="separator:a124ab620c7b3aa805ea8b0086ba0c344"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afccd0de81f7e5dc6bc19ce61eae38e92"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#afccd0de81f7e5dc6bc19ce61eae38e92">XVprocSs_SetPictureSaturation</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, s32 NewValue)</td></tr>
<tr class="memdesc:afccd0de81f7e5dc6bc19ce61eae38e92"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function updates picture saturation setting with specified value.  <a href="#afccd0de81f7e5dc6bc19ce61eae38e92">More...</a><br /></td></tr>
<tr class="separator:afccd0de81f7e5dc6bc19ce61eae38e92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8e9990e57b17ac9bdd9a911153ddbfe"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#af8e9990e57b17ac9bdd9a911153ddbfe">XVprocSs_GetPictureGain</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, <a class="el" href="xvprocss_8h.html#a7d60f719453eb6b2145c6a9cfa45422f">XVprocSs_ColorChannel</a> ChId)</td></tr>
<tr class="memdesc:af8e9990e57b17ac9bdd9a911153ddbfe"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns picture gain setting for the specified color channel.  <a href="#af8e9990e57b17ac9bdd9a911153ddbfe">More...</a><br /></td></tr>
<tr class="separator:af8e9990e57b17ac9bdd9a911153ddbfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05099b854831e91e4a2d6c39395c267d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a05099b854831e91e4a2d6c39395c267d">XVprocSs_SetPictureGain</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, <a class="el" href="xvprocss_8h.html#a7d60f719453eb6b2145c6a9cfa45422f">XVprocSs_ColorChannel</a> ChId, s32 NewValue)</td></tr>
<tr class="memdesc:a05099b854831e91e4a2d6c39395c267d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function updates picture gain setting with specified value.  <a href="#a05099b854831e91e4a2d6c39395c267d">More...</a><br /></td></tr>
<tr class="separator:a05099b854831e91e4a2d6c39395c267d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0002b9c7a313219e4701514fe3acae7b"><td class="memItemLeft" align="right" valign="top">XVidC_ColorStd&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a0002b9c7a313219e4701514fe3acae7b">XVprocSs_GetPictureColorStdIn</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:a0002b9c7a313219e4701514fe3acae7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns picture color standard setting for input.  <a href="#a0002b9c7a313219e4701514fe3acae7b">More...</a><br /></td></tr>
<tr class="separator:a0002b9c7a313219e4701514fe3acae7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b8d6dc56403962ed56cba01b01a3c2f"><td class="memItemLeft" align="right" valign="top">XVidC_ColorStd&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a9b8d6dc56403962ed56cba01b01a3c2f">XVprocSs_GetPictureColorStdOut</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:a9b8d6dc56403962ed56cba01b01a3c2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns picture color standard setting for output.  <a href="#a9b8d6dc56403962ed56cba01b01a3c2f">More...</a><br /></td></tr>
<tr class="separator:a9b8d6dc56403962ed56cba01b01a3c2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0b45fe8442626962284f22ea54e3d43"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#aa0b45fe8442626962284f22ea54e3d43">XVprocSs_SetPictureColorStdIn</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, XVidC_ColorStd NewVal)</td></tr>
<tr class="memdesc:aa0b45fe8442626962284f22ea54e3d43"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets picture color standard setting for input.  <a href="#aa0b45fe8442626962284f22ea54e3d43">More...</a><br /></td></tr>
<tr class="separator:aa0b45fe8442626962284f22ea54e3d43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01d3ff2ed3b9bb9c8808b187d1d685a6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a01d3ff2ed3b9bb9c8808b187d1d685a6">XVprocSs_SetPictureColorStdOut</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, XVidC_ColorStd NewVal)</td></tr>
<tr class="memdesc:a01d3ff2ed3b9bb9c8808b187d1d685a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets picture color standard setting for output.  <a href="#a01d3ff2ed3b9bb9c8808b187d1d685a6">More...</a><br /></td></tr>
<tr class="separator:a01d3ff2ed3b9bb9c8808b187d1d685a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b0ba7cd1d7384d9acd813d3b38f2979"><td class="memItemLeft" align="right" valign="top">XVidC_ColorRange&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a0b0ba7cd1d7384d9acd813d3b38f2979">XVprocSs_GetPictureColorRange</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:a0b0ba7cd1d7384d9acd813d3b38f2979"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns picture color range for output.  <a href="#a0b0ba7cd1d7384d9acd813d3b38f2979">More...</a><br /></td></tr>
<tr class="separator:a0b0ba7cd1d7384d9acd813d3b38f2979"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa0f891d54cc88f0fd6d4ef93960aec1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#aaa0f891d54cc88f0fd6d4ef93960aec1">XVprocSs_SetPictureColorRange</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, XVidC_ColorRange NewVal)</td></tr>
<tr class="memdesc:aaa0f891d54cc88f0fd6d4ef93960aec1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets picture color range for output.  <a href="#aaa0f891d54cc88f0fd6d4ef93960aec1">More...</a><br /></td></tr>
<tr class="separator:aaa0f891d54cc88f0fd6d4ef93960aec1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab56e5e6f01e06d85a9f1e50ea1123413"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#ab56e5e6f01e06d85a9f1e50ea1123413">XVprocSs_SetPictureDemoWindow</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, XVidC_VideoWindow *Win)</td></tr>
<tr class="memdesc:ab56e5e6f01e06d85a9f1e50ea1123413"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets picture Demo Window.  <a href="#ab56e5e6f01e06d85a9f1e50ea1123413">More...</a><br /></td></tr>
<tr class="separator:ab56e5e6f01e06d85a9f1e50ea1123413"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34d1e25e364c4699c60ee30839f141f7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a34d1e25e364c4699c60ee30839f141f7">XVprocSs_SetPIPBackgroundColor</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, XLboxColorId ColorId)</td></tr>
<tr class="memdesc:a34d1e25e364c4699c60ee30839f141f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets PIP background color.  <a href="#a34d1e25e364c4699c60ee30839f141f7">More...</a><br /></td></tr>
<tr class="separator:a34d1e25e364c4699c60ee30839f141f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e48068cf0d1c946986e64b53cb24cc8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a1e48068cf0d1c946986e64b53cb24cc8">XVprocSs_LoadScalerCoeff</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, u32 CoreId, u16 num_phases, u16 num_taps, const short *Coeff)</td></tr>
<tr class="memdesc:a1e48068cf0d1c946986e64b53cb24cc8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function enables user to load external filter coefficients for Scaler cores, independently for H &amp; V.  <a href="#a1e48068cf0d1c946986e64b53cb24cc8">More...</a><br /></td></tr>
<tr class="separator:a1e48068cf0d1c946986e64b53cb24cc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a45d3f05110a0eda88d959ecae7cd07"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#a7a45d3f05110a0eda88d959ecae7cd07">XVprocSs_LoadChromaResamplerCoeff</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, u32 CoreId, u16 num_taps, const short *Coeff)</td></tr>
<tr class="memdesc:a7a45d3f05110a0eda88d959ecae7cd07"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function enables user to load external filter coefficients for Chroma Resampler cores, independently for H &amp; V.  <a href="#a7a45d3f05110a0eda88d959ecae7cd07">More...</a><br /></td></tr>
<tr class="separator:a7a45d3f05110a0eda88d959ecae7cd07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc2dd89a8c01c86bf6093d842db67262"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#acc2dd89a8c01c86bf6093d842db67262">XVprocSs_ReportSubcoreStatus</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr, u32 SubcoreId)</td></tr>
<tr class="memdesc:acc2dd89a8c01c86bf6093d842db67262"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reports the status of specified sub-core.  <a href="#acc2dd89a8c01c86bf6093d842db67262">More...</a><br /></td></tr>
<tr class="separator:acc2dd89a8c01c86bf6093d842db67262"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3ef2fc6d79df8ccb528644f8e539828"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#af3ef2fc6d79df8ccb528644f8e539828">XVprocSs_ReportSubsystemCoreInfo</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:af3ef2fc6d79df8ccb528644f8e539828"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reports Video Processing Subsystem HW configuration.  <a href="#af3ef2fc6d79df8ccb528644f8e539828">More...</a><br /></td></tr>
<tr class="separator:af3ef2fc6d79df8ccb528644f8e539828"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe70027604ba640917538338703b4a7f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xvprocss_8c.html#abe70027604ba640917538338703b4a7f">XVprocSs_ReportSubsystemConfig</a> (<a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *InstancePtr)</td></tr>
<tr class="memdesc:abe70027604ba640917538338703b4a7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function reports the subsystem HW and input/output stream configuration.  <a href="#abe70027604ba640917538338703b4a7f">More...</a><br /></td></tr>
<tr class="separator:abe70027604ba640917538338703b4a7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a4fb66632e7266e1abf4292b8ec819b50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fb66632e7266e1abf4292b8ec819b50">&#9670;&nbsp;</a></span>XVPROCSS_RSTMASK_IP_AXIMM</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XVPROCSS_RSTMASK_IP_AXIMM&#160;&#160;&#160;(0x01)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reset line for vpss internal AXI-MM blocks. </p>

</div>
</div>
<a id="af87c7ccc12aec9201a98d39d7e186a2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af87c7ccc12aec9201a98d39d7e186a2d">&#9670;&nbsp;</a></span>XVPROCSS_RSTMASK_IP_AXIS</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XVPROCSS_RSTMASK_IP_AXIS&#160;&#160;&#160;(0x02)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reset line for vpss internal video IP blocks. </p>

</div>
</div>
<a id="a222fde5e6896742abd771d50c488118b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a222fde5e6896742abd771d50c488118b">&#9670;&nbsp;</a></span>XVPROCSS_RSTMASK_VIDEO_IN</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XVPROCSS_RSTMASK_VIDEO_IN&#160;&#160;&#160;(0x01)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reset line going out of vpss. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="aac138624e6b5449040be8bd02710a512"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac138624e6b5449040be8bd02710a512">&#9670;&nbsp;</a></span>XVprocSs_CfgInitialize()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVprocSs_CfgInitialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss___config.html">XVprocSs_Config</a> *&#160;</td>
          <td class="paramname"><em>CfgPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">UINTPTR&#160;</td>
          <td class="paramname"><em>EffectiveAddr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function initializes the video subsystem and included sub-cores. </p>
<p>This function must be called prior to using the subsystem. Initialization includes setting up the instance data for top level as well as all included sub-core therein, and ensuring the hardware is in a known stable state.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
    <tr><td class="paramname">CfgPtr</td><td>points to the configuration structure associated with the subsystem instance. </td></tr>
    <tr><td class="paramname">EffectiveAddr</td><td>is the base address of the device. If address translation is being used, then this parameter must reflect the virtual base address. Otherwise, the physical address should be used.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if initialization is successful else XST_FAILURE </dd></dl>

<p class="reference">References <a class="el" href="group__vprocss.html#ggadda80cee8527fb0dac1e98e657f12cd9acc9fe81f5f5652e44b0769a046a02490">XVPROCSS_EVT_INIT</a>, and <a class="el" href="xvprocss_8h.html#a477ddfa18fa5fda8658ec72fb29a2d25">XVprocSs_LogWrite()</a>.</p>

</div>
</div>
<a id="a84c2f382ff78d4cc1c42628d0821870c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84c2f382ff78d4cc1c42628d0821870c">&#9670;&nbsp;</a></span>XVprocSs_GetPictureBrightness()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XVprocSs_GetPictureBrightness </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function returns picture brighntess setting. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>current value (0-100), if csc subcore is included </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a70745e8e343154d82af157d3a50eca31">XVprocSs::CscPtr</a>.</p>

</div>
</div>
<a id="a0b0ba7cd1d7384d9acd813d3b38f2979"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b0ba7cd1d7384d9acd813d3b38f2979">&#9670;&nbsp;</a></span>XVprocSs_GetPictureColorRange()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XVidC_ColorRange XVprocSs_GetPictureColorRange </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function returns picture color range for output. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Current set output range, if csc core is included<ul>
<li>XVIDC_CR_16_235</li>
<li>XVIDC_CR_16_240</li>
</ul>
</dd></dl>
<ul>
<li>XVIDC_CR_0_255 Else XVIDC_CR_UNKNOWN_RANGE </li>
</ul>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a70745e8e343154d82af157d3a50eca31">XVprocSs::CscPtr</a>.</p>

</div>
</div>
<a id="a0002b9c7a313219e4701514fe3acae7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0002b9c7a313219e4701514fe3acae7b">&#9670;&nbsp;</a></span>XVprocSs_GetPictureColorStdIn()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XVidC_ColorStd XVprocSs_GetPictureColorStdIn </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function returns picture color standard setting for input. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Current set color standard, if csc core is included<ul>
<li>XVIDC_BT_2020</li>
<li>XVIDC_BT_709</li>
<li>XVIDC_BT_601 Else XVIDC_BT_UNKNOWN </li>
</ul>
</dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a70745e8e343154d82af157d3a50eca31">XVprocSs::CscPtr</a>.</p>

</div>
</div>
<a id="a9b8d6dc56403962ed56cba01b01a3c2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b8d6dc56403962ed56cba01b01a3c2f">&#9670;&nbsp;</a></span>XVprocSs_GetPictureColorStdOut()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XVidC_ColorStd XVprocSs_GetPictureColorStdOut </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function returns picture color standard setting for output. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Current set color standard, if csc core is included<ul>
<li>XVIDC_BT_2020</li>
<li>XVIDC_BT_709</li>
<li>XVIDC_BT_601 Else XVIDC_BT_UNKNOWN </li>
</ul>
</dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a70745e8e343154d82af157d3a50eca31">XVprocSs::CscPtr</a>.</p>

</div>
</div>
<a id="a628456c68064dcf093ecd1f7097e2879"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a628456c68064dcf093ecd1f7097e2879">&#9670;&nbsp;</a></span>XVprocSs_GetPictureContrast()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XVprocSs_GetPictureContrast </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function returns picture contrast setting. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>current value (0-100), if csc subcore is included </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a70745e8e343154d82af157d3a50eca31">XVprocSs::CscPtr</a>.</p>

</div>
</div>
<a id="af8e9990e57b17ac9bdd9a911153ddbfe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8e9990e57b17ac9bdd9a911153ddbfe">&#9670;&nbsp;</a></span>XVprocSs_GetPictureGain()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XVprocSs_GetPictureGain </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="xvprocss_8h.html#a7d60f719453eb6b2145c6a9cfa45422f">XVprocSs_ColorChannel</a>&#160;</td>
          <td class="paramname"><em>ChId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function returns picture gain setting for the specified color channel. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
    <tr><td class="paramname">ChId</td><td>is the color channel id for which gain is requested</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>current value (0-100), if csc subcore is included </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a70745e8e343154d82af157d3a50eca31">XVprocSs::CscPtr</a>.</p>

</div>
</div>
<a id="a124ab620c7b3aa805ea8b0086ba0c344"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a124ab620c7b3aa805ea8b0086ba0c344">&#9670;&nbsp;</a></span>XVprocSs_GetPictureSaturation()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XVprocSs_GetPictureSaturation </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function returns picture saturation setting. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>current value (0-100), if csc subcore is included </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a70745e8e343154d82af157d3a50eca31">XVprocSs::CscPtr</a>.</p>

</div>
</div>
<a id="a55d0807b3f476d2608a8c49b44388fec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55d0807b3f476d2608a8c49b44388fec">&#9670;&nbsp;</a></span>XVprocSs_GetZoomPipWindow()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_GetZoomPipWindow </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="xvprocss_8h.html#a0743bfb208145c415f5af1ba231245a6">XVprocSs_Win</a>&#160;</td>
          <td class="paramname"><em>mode</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XVidC_VideoWindow *&#160;</td>
          <td class="paramname"><em>win</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reads the user defined Zoom/Pip window from scratch pad memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
    <tr><td class="paramname">mode</td><td>is feature (PIP or ZOOM) whose window coordinates are to be retrieved </td></tr>
    <tr><td class="paramname">win</td><td>is structure that will contain read window coordinates and size</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>For Zoom mode RD client window is read from scratch pad memory For Pip mode WR client window is read from scratch pad memory This function is not applicable in Subsystem Stream Mode Configuration </dd></dl>

<p class="reference">References <a class="el" href="xvprocss_8h.html#ab0a3f8f3946c8d71bac750de3c62b2c8">XVprocSs_IsConfigModeMax</a>.</p>

<p class="reference">Referenced by <a class="el" href="xvprocss_8h.html#abe70027604ba640917538338703b4a7f">XVprocSs_ReportSubsystemConfig()</a>.</p>

</div>
</div>
<a id="a7a45d3f05110a0eda88d959ecae7cd07"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a45d3f05110a0eda88d959ecae7cd07">&#9670;&nbsp;</a></span>XVprocSs_LoadChromaResamplerCoeff()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_LoadChromaResamplerCoeff </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>CoreId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>num_taps</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const short *&#160;</td>
          <td class="paramname"><em>Coeff</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function enables user to load external filter coefficients for Chroma Resampler cores, independently for H &amp; V. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
    <tr><td class="paramname">CoreId</td><td>is the resampler core to be worked on<ul>
<li>XVPROCSS_SUBCORE_CR_H</li>
<li>XVPROCSS_SUBCORE_CR_V_IN</li>
<li>XVPROCSS_SUBCORE_CR_V_OUT </li>
</ul>
</td></tr>
    <tr><td class="paramname">num_taps</td><td>is the taps of the resampler hw instance </td></tr>
    <tr><td class="paramname">Coeff</td><td>is the pointer to the filter table to be loaded</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Applicable only if Resampler cores are included in the subsystem </dd></dl>

</div>
</div>
<a id="a1e48068cf0d1c946986e64b53cb24cc8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e48068cf0d1c946986e64b53cb24cc8">&#9670;&nbsp;</a></span>XVprocSs_LoadScalerCoeff()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_LoadScalerCoeff </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>CoreId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>num_phases</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>num_taps</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const short *&#160;</td>
          <td class="paramname"><em>Coeff</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function enables user to load external filter coefficients for Scaler cores, independently for H &amp; V. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
    <tr><td class="paramname">CoreId</td><td>is the Scaler core to be worked on<ul>
<li>XVPROCSS_SUBCORE_SCALER_V</li>
<li>XVPROCSS_SUBCORE_SCALER_H </li>
</ul>
</td></tr>
    <tr><td class="paramname">num_phases</td><td>is the number of phases supported by Scaler </td></tr>
    <tr><td class="paramname">num_taps</td><td>is the effective taps to be used by Scaler </td></tr>
    <tr><td class="paramname">Coeff</td><td>is the pointer to the filter table to be loaded</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Applicable only if Scaler cores are included in the subsystem </dd></dl>

</div>
</div>
<a id="acc2dd89a8c01c86bf6093d842db67262"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc2dd89a8c01c86bf6093d842db67262">&#9670;&nbsp;</a></span>XVprocSs_ReportSubcoreStatus()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_ReportSubcoreStatus </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>SubcoreId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reports the status of specified sub-core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
    <tr><td class="paramname">SubcoreId</td><td>is the subcore index from the below list<ul>
<li>XVPROCSS_SUBCORE_SCALER_V</li>
<li>XVPROCSS_SUBCORE_SCALER_H</li>
<li>XVPROCSS_SUBCORE_VDMA</li>
<li>XVPROCSS_SUBCORE_LBOX</li>
<li>XVPROCSS_SUBCORE_CR_H</li>
<li>XVPROCSS_SUBCORE_CR_V_IN</li>
<li>XVPROCSS_SUBCORE_CR_V_OUT</li>
<li>XVPROCSS_SUBCORE_CSC</li>
<li>XVPROCSS_SUBCORE_DEINT</li>
</ul>
</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

</div>
</div>
<a id="abe70027604ba640917538338703b4a7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe70027604ba640917538338703b4a7f">&#9670;&nbsp;</a></span>XVprocSs_ReportSubsystemConfig()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_ReportSubsystemConfig </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reports the subsystem HW and input/output stream configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a6440efa76dbba290ebfdd4b603cff0b2">XVprocSs::VidIn</a>, <a class="el" href="struct_x_vproc_ss.html#a1fce9dc484558616980012f4a77764ee">XVprocSs::VidOut</a>, <a class="el" href="xvprocss_8c.html#a55d0807b3f476d2608a8c49b44388fec">XVprocSs_GetZoomPipWindow()</a>, <a class="el" href="xvprocss_8h.html#ab0a3f8f3946c8d71bac750de3c62b2c8">XVprocSs_IsConfigModeMax</a>, and <a class="el" href="xvprocss_8h.html#a85ac472cadd748d636762b1ef1a2c418">XVprocSs_IsZoomModeOn</a>.</p>

</div>
</div>
<a id="af3ef2fc6d79df8ccb528644f8e539828"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3ef2fc6d79df8ccb528644f8e539828">&#9670;&nbsp;</a></span>XVprocSs_ReportSubsystemCoreInfo()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_ReportSubsystemCoreInfo </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function reports Video Processing Subsystem HW configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

</div>
</div>
<a id="ab65fda7ce63456d82274a463a4d4b72a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab65fda7ce63456d82274a463a4d4b72a">&#9670;&nbsp;</a></span>XVprocSs_Reset()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_Reset </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function resets the video subsystem sub-cores. </p>
<p>There are 2 reset networks within the subsystem</p><ul>
<li>For cores that are on AXIS interface</li>
<li>For cores that are on AXI-MM interface</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<p>XVprocSs_Reset,_Start controls vpss resets as shown axis_int -&mdash;_______________________-----------------------------&mdash; axis_ext -&mdash;________________________________________________----&mdash; aximm --------&mdash;_______--------------------------------------&mdash; | 100us| 100us| 1000us | 1000us | | _Reset...............................| | Program VSPP IP| _Start </p>

</div>
</div>
<a id="a650457b5f1b57842c2e3edd06d1de480"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a650457b5f1b57842c2e3edd06d1de480">&#9670;&nbsp;</a></span>XVprocSs_SetFrameBufBaseaddr()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_SetFrameBufBaseaddr </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">UINTPTR&#160;</td>
          <td class="paramname"><em>addr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets the base address of the video frame buffers used by the subsystem instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
    <tr><td class="paramname">addr</td><td>is the base address of the video frame buffers</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a57e2cd4a8866527f62302b602121e884">XVprocSs::FrameBufBaseaddr</a>.</p>

</div>
</div>
<a id="a186ce7049ca9f0bcaf1a5e76866fbf31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a186ce7049ca9f0bcaf1a5e76866fbf31">&#9670;&nbsp;</a></span>XVprocSs_SetPictureBrightness()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_SetPictureBrightness </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">s32&#160;</td>
          <td class="paramname"><em>NewValue</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function updates picture brighntess setting with specified value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
    <tr><td class="paramname">NewValue</td><td>is the new value to be written<ul>
<li>Range: 0-100</li>
</ul>
</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Applicable only if CSC core is included in the subsystem </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a70745e8e343154d82af157d3a50eca31">XVprocSs::CscPtr</a>.</p>

</div>
</div>
<a id="aaa0f891d54cc88f0fd6d4ef93960aec1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa0f891d54cc88f0fd6d4ef93960aec1">&#9670;&nbsp;</a></span>XVprocSs_SetPictureColorRange()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_SetPictureColorRange </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XVidC_ColorRange&#160;</td>
          <td class="paramname"><em>NewVal</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets picture color range for output. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
    <tr><td class="paramname">NewVal</td><td>is the required color range<ul>
<li>XVIDC_CR_16_235</li>
<li>XVIDC_CR_16_240</li>
</ul>
</td></tr>
  </table>
  </dd>
</dl>
<ul>
<li>XVIDC_CR_0_255</li>
</ul>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Applicable only if CSC core is included in the subsystem </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a70745e8e343154d82af157d3a50eca31">XVprocSs::CscPtr</a>.</p>

</div>
</div>
<a id="aa0b45fe8442626962284f22ea54e3d43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0b45fe8442626962284f22ea54e3d43">&#9670;&nbsp;</a></span>XVprocSs_SetPictureColorStdIn()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_SetPictureColorStdIn </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XVidC_ColorStd&#160;</td>
          <td class="paramname"><em>NewVal</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets picture color standard setting for input. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
    <tr><td class="paramname">NewVal</td><td>is the required color standard<ul>
<li>XVIDC_BT_2020</li>
<li>XVIDC_BT_709</li>
<li>XVIDC_BT_601</li>
</ul>
</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Applicable only if CSC core is included in the subsystem </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a70745e8e343154d82af157d3a50eca31">XVprocSs::CscPtr</a>.</p>

</div>
</div>
<a id="a01d3ff2ed3b9bb9c8808b187d1d685a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01d3ff2ed3b9bb9c8808b187d1d685a6">&#9670;&nbsp;</a></span>XVprocSs_SetPictureColorStdOut()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_SetPictureColorStdOut </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XVidC_ColorStd&#160;</td>
          <td class="paramname"><em>NewVal</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets picture color standard setting for output. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
    <tr><td class="paramname">NewVal</td><td>is the required color standard<ul>
<li>XVIDC_BT_2020</li>
<li>XVIDC_BT_709</li>
<li>XVIDC_BT_601</li>
</ul>
</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Applicable only if CSC core is included in the subsystem </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a70745e8e343154d82af157d3a50eca31">XVprocSs::CscPtr</a>.</p>

</div>
</div>
<a id="a65dcb2906de961ca823262f6b6039b87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65dcb2906de961ca823262f6b6039b87">&#9670;&nbsp;</a></span>XVprocSs_SetPictureContrast()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_SetPictureContrast </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">s32&#160;</td>
          <td class="paramname"><em>NewValue</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function updates picture contrast setting with specified value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
    <tr><td class="paramname">NewValue</td><td>is the new value to be written<ul>
<li>Range: 0-100</li>
</ul>
</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Applicable only if CSC core is included in the subsystem </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a70745e8e343154d82af157d3a50eca31">XVprocSs::CscPtr</a>.</p>

</div>
</div>
<a id="ab56e5e6f01e06d85a9f1e50ea1123413"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab56e5e6f01e06d85a9f1e50ea1123413">&#9670;&nbsp;</a></span>XVprocSs_SetPictureDemoWindow()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVprocSs_SetPictureDemoWindow </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XVidC_VideoWindow *&#160;</td>
          <td class="paramname"><em>Win</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets picture Demo Window. </p>
<p>Post this function call all further picture settings will apply only within the defined window. Demo window gets reset everytime subsystem configuration changes</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
    <tr><td class="paramname">Win</td><td>is the pointer to window coordinates within which picture settings should be applied</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if window is valid else XST_FAILURE</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Applicable only if CSC core is included in the subsystem and the Demo Window is enabled </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a70745e8e343154d82af157d3a50eca31">XVprocSs::CscPtr</a>, <a class="el" href="group__vprocss.html#ggadda80cee8527fb0dac1e98e657f12cd9a69ed478af62bfb13c0e68251ca18b3da">XVPROCSS_EVT_CFG_CSC</a>, and <a class="el" href="xvprocss_8h.html#a477ddfa18fa5fda8658ec72fb29a2d25">XVprocSs_LogWrite()</a>.</p>

</div>
</div>
<a id="a05099b854831e91e4a2d6c39395c267d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05099b854831e91e4a2d6c39395c267d">&#9670;&nbsp;</a></span>XVprocSs_SetPictureGain()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_SetPictureGain </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="xvprocss_8h.html#a7d60f719453eb6b2145c6a9cfa45422f">XVprocSs_ColorChannel</a>&#160;</td>
          <td class="paramname"><em>ChId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">s32&#160;</td>
          <td class="paramname"><em>NewValue</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function updates picture gain setting with specified value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
    <tr><td class="paramname">ChId</td><td>is the color channel id for which gain is to be updated </td></tr>
    <tr><td class="paramname">NewValue</td><td>is the new value to be written<ul>
<li>Range: 0-100</li>
</ul>
</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Applicable only if CSC core is included in the subsystem </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a70745e8e343154d82af157d3a50eca31">XVprocSs::CscPtr</a>.</p>

</div>
</div>
<a id="afccd0de81f7e5dc6bc19ce61eae38e92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afccd0de81f7e5dc6bc19ce61eae38e92">&#9670;&nbsp;</a></span>XVprocSs_SetPictureSaturation()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_SetPictureSaturation </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">s32&#160;</td>
          <td class="paramname"><em>NewValue</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function updates picture saturation setting with specified value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
    <tr><td class="paramname">NewValue</td><td>is the new value to be written<ul>
<li>Range: 0-100</li>
</ul>
</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Applicable only if CSC core is included in the subsystem </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a70745e8e343154d82af157d3a50eca31">XVprocSs::CscPtr</a>.</p>

</div>
</div>
<a id="a34d1e25e364c4699c60ee30839f141f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34d1e25e364c4699c60ee30839f141f7">&#9670;&nbsp;</a></span>XVprocSs_SetPIPBackgroundColor()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_SetPIPBackgroundColor </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XLboxColorId&#160;</td>
          <td class="paramname"><em>ColorId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets PIP background color. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
    <tr><td class="paramname">ColorIs</td><td>is the requested background color<ul>
<li>XLBOX_BKGND_BLACK</li>
<li>XLBOX_BKGND_WHITE</li>
<li>XLBOX_BKGND_RED</li>
<li>XLBOX_BKGND_GREEN</li>
<li>XLBOX_BKGND_BLUE</li>
</ul>
</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Applicable only if Letterbox core is included in the subsystem </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#ad05c179ff8b000570b16a8ac39f885d7">XVprocSs::CtxtData</a>, <a class="el" href="struct_x_vproc_ss___context_data.html#a8f080227d4a5195ea3ec54dc12206e33">XVprocSs_ContextData::LboxBkgndColor</a>, <a class="el" href="struct_x_vproc_ss.html#a7cc8183d534f77c5bf240616db3df97d">XVprocSs::LboxPtr</a>, <a class="el" href="struct_x_vproc_ss___context_data.html#a8e3923646d6b89ff1970f62e0d63d259">XVprocSs_ContextData::StrmCformat</a>, <a class="el" href="struct_x_vproc_ss.html#a6440efa76dbba290ebfdd4b603cff0b2">XVprocSs::VidIn</a>, <a class="el" href="group__vprocss.html#ggadda80cee8527fb0dac1e98e657f12cd9a59c1a12d3255327b3fd10fe3c6e1cbd7">XVPROCSS_EVT_SET_PIPMODE</a>, and <a class="el" href="xvprocss_8h.html#a477ddfa18fa5fda8658ec72fb29a2d25">XVprocSs_LogWrite()</a>.</p>

</div>
</div>
<a id="a84b1254cbeac02b7f81b1b90c721e84d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84b1254cbeac02b7f81b1b90c721e84d">&#9670;&nbsp;</a></span>XVprocSs_SetPipMode()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_SetPipMode </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>OnOff</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function configures the video subsystem to enable/disable PIP feature If PIP mode is set to ON but user has not set window coordinates then half of input stream resolution at coordinates 0,0 is set as the default zoom window. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
    <tr><td class="paramname">OnOff</td><td>is the action required</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>User must call XVprocSs_ConfigureSubsystem() for change to take effect This call has not been added here such that it provides an opportunity to make the change during vertical blanking at system level. This behavior will change once shadow register support is available in sub-core IP's This function is not applicable in Subsystem Stream Mode Configuration </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#ad05c179ff8b000570b16a8ac39f885d7">XVprocSs::CtxtData</a>, <a class="el" href="struct_x_vproc_ss___context_data.html#a153a8ddde9a7c9d7b4fd9abb01339af2">XVprocSs_ContextData::PipEn</a>, <a class="el" href="group__vprocss.html#ggadda80cee8527fb0dac1e98e657f12cd9a59c1a12d3255327b3fd10fe3c6e1cbd7">XVPROCSS_EVT_SET_PIPMODE</a>, <a class="el" href="xvprocss_8h.html#ab0a3f8f3946c8d71bac750de3c62b2c8">XVprocSs_IsConfigModeMax</a>, <a class="el" href="xvprocss_8h.html#a477ddfa18fa5fda8658ec72fb29a2d25">XVprocSs_LogWrite()</a>, and <a class="el" href="struct_x_vproc_ss___context_data.html#a2295b97e85e14cba835e65ce302a7076">XVprocSs_ContextData::ZoomEn</a>.</p>

</div>
</div>
<a id="a02c12d52974b723d6f5bb6d7fa0aa754"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02c12d52974b723d6f5bb6d7fa0aa754">&#9670;&nbsp;</a></span>XVprocSs_SetStreamResolution()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVprocSs_SetStreamResolution </td>
          <td>(</td>
          <td class="paramtype">XVidC_VideoStream *&#160;</td>
          <td class="paramname"><em>StreamPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const XVidC_VideoMode&#160;</td>
          <td class="paramname"><em>VmId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XVidC_VideoTiming const *&#160;</td>
          <td class="paramname"><em>Timing</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets the required subsystem video stream to the user provided stream and timing parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">StreamPtr</td><td>is a pointer to the subsystem video stream to be configured </td></tr>
    <tr><td class="paramname">VmId</td><td>is the Video Mode ID of the new resolution to be set </td></tr>
    <tr><td class="paramname">Timing</td><td>is the timing parameters of the new resolution to be set</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful else XST_FAILURE </dd></dl>

</div>
</div>
<a id="a49bdfcfcf9abb02829a7baf6603151f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49bdfcfcf9abb02829a7baf6603151f2">&#9670;&nbsp;</a></span>XVprocSs_SetSubsystemConfig()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVprocSs_SetSubsystemConfig </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is the entry point into the video processing subsystem driver processing path. </p>
<p>It will examine the instantiated subsystem configuration mode and the input and output stream configuration. Based on the available information control flow is determined and requisite sub-cores are configured to implement the supported use case</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful else XST_FAILURE </dd></dl>

</div>
</div>
<a id="add7069c7a21fe0cf07779dcb945cab96"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add7069c7a21fe0cf07779dcb945cab96">&#9670;&nbsp;</a></span>XVprocSs_SetUserTimerHandler()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_SetUserTimerHandler </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XVidC_DelayHandler&#160;</td>
          <td class="paramname"><em>CallbackFunc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallbackRef</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function registers the user defined delay/sleep function with subsystem. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance </td></tr>
    <tr><td class="paramname">CallbackFunc</td><td>is the function pointer to the user defined delay function </td></tr>
    <tr><td class="paramname">CallbackRef</td><td>is the pointer to timer instance used by the delay function</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a7eb355254239a53c3c14cccdcc4d8045">XVprocSs::UsrDelayUs</a>, and <a class="el" href="struct_x_vproc_ss.html#a4a2b5a8f4a791f610db50f9a5c4032dd">XVprocSs::UsrTmrPtr</a>.</p>

</div>
</div>
<a id="a47c310a89b7072313404485d4bb9b03f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47c310a89b7072313404485d4bb9b03f">&#9670;&nbsp;</a></span>XVprocSs_SetVidStreamIn()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVprocSs_SetVidStreamIn </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const XVidC_VideoStream *&#160;</td>
          <td class="paramname"><em>StrmIn</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function configures the video subsystem input interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
    <tr><td class="paramname">StrmIn</td><td>is the pointer to input stream configuration</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a6440efa76dbba290ebfdd4b603cff0b2">XVprocSs::VidIn</a>.</p>

</div>
</div>
<a id="a28fae690c023b4d8b7a1d9b9c68c966c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28fae690c023b4d8b7a1d9b9c68c966c">&#9670;&nbsp;</a></span>XVprocSs_SetVidStreamOut()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVprocSs_SetVidStreamOut </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const XVidC_VideoStream *&#160;</td>
          <td class="paramname"><em>StrmOut</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function configures the video subsystem output interface. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
    <tr><td class="paramname">StrmOut</td><td>is the pointer to input stream configuration</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a1fce9dc484558616980012f4a77764ee">XVprocSs::VidOut</a>.</p>

</div>
</div>
<a id="a799db27e282d2762ee5cf4be40e70712"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a799db27e282d2762ee5cf4be40e70712">&#9670;&nbsp;</a></span>XVprocSs_SetZoomMode()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_SetZoomMode </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>OnOff</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function configures the video subsystem to enable/disable ZOOM feature If ZOOM mode is set to ON but user has not set window coordinates then quarter of input stream resolution at coordinates 0,0 is set as the default zoom window. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
    <tr><td class="paramname">OnOff</td><td>is the action required</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>User must call XVprocSs_ConfigureSubsystem() for change to take effect This call has not been added here such that it provides an opportunity to make the change during vertical blanking at system level. This behavior will change once shadow register support is available in sub-core IP's This function is not applicable in Subsystem Stream Mode Configuration </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#ad05c179ff8b000570b16a8ac39f885d7">XVprocSs::CtxtData</a>, <a class="el" href="struct_x_vproc_ss___context_data.html#a153a8ddde9a7c9d7b4fd9abb01339af2">XVprocSs_ContextData::PipEn</a>, <a class="el" href="group__vprocss.html#ggadda80cee8527fb0dac1e98e657f12cd9a558e3ec01039cf251147be690d2bd9ec">XVPROCSS_EVT_SET_ZOOMMODE</a>, <a class="el" href="xvprocss_8h.html#ab0a3f8f3946c8d71bac750de3c62b2c8">XVprocSs_IsConfigModeMax</a>, <a class="el" href="xvprocss_8h.html#a477ddfa18fa5fda8658ec72fb29a2d25">XVprocSs_LogWrite()</a>, and <a class="el" href="struct_x_vproc_ss___context_data.html#a2295b97e85e14cba835e65ce302a7076">XVprocSs_ContextData::ZoomEn</a>.</p>

</div>
</div>
<a id="a8293d3dc637bc8c481b205d2272b4fc2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8293d3dc637bc8c481b205d2272b4fc2">&#9670;&nbsp;</a></span>XVprocSs_SetZoomPipWindow()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_SetZoomPipWindow </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="xvprocss_8h.html#a0743bfb208145c415f5af1ba231245a6">XVprocSs_Win</a>&#160;</td>
          <td class="paramname"><em>mode</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XVidC_VideoWindow *&#160;</td>
          <td class="paramname"><em>win</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function allows user to set the Zoom or PIP window. </p>
<p>Scratch pad memory is updated with the new window information</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on. </td></tr>
    <tr><td class="paramname">mode</td><td>is feature to be updated PIP or ZOOM </td></tr>
    <tr><td class="paramname">win</td><td>is structure that contains window coordinates and size</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>For Zoom mode RD client window is written in scratch pad memory For Pip mode WR client window is written in scratch pad memory This function is not applicable in Subsystem Stream Mode Configuration </dd></dl>

<p class="reference">References <a class="el" href="xvprocss_8h.html#ab0a3f8f3946c8d71bac750de3c62b2c8">XVprocSs_IsConfigModeMax</a>.</p>

</div>
</div>
<a id="a0f673d448bb7702661b702519de94fd9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f673d448bb7702661b702519de94fd9">&#9670;&nbsp;</a></span>XVprocSs_Start()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_Start </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function starts the video subsystem including all sub-cores that are included in the processing pipeline for a given use-case. </p>
<p>Video pipe is started from back to front </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Cores are started only if the corresponding start flag in the scratch pad memory is set. This allows to selectively start only those cores included in the processing chain </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#ad05c179ff8b000570b16a8ac39f885d7">XVprocSs::CtxtData</a>, and <a class="el" href="struct_x_vproc_ss___context_data.html#aa02a961464f60d239452ebc287a02b98">XVprocSs_ContextData::StartCore</a>.</p>

</div>
</div>
<a id="a1f28821282af5defa07408d1c00c2bfe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f28821282af5defa07408d1c00c2bfe">&#9670;&nbsp;</a></span>XVprocSs_Stop()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_Stop </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function stops the video subsystem including all sub-cores Stop the video pipe starting from front to back. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#a70745e8e343154d82af157d3a50eca31">XVprocSs::CscPtr</a>, <a class="el" href="struct_x_vproc_ss.html#ae5a31f08bd16f24a746eceb0ebe7dd09">XVprocSs::DeintPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a554c32cace7c2bcc2637919e17ad0945">XVprocSs::HcrsmplrPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a96d7da785b43ce54736523b9de33ee3e">XVprocSs::HscalerPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a7cc8183d534f77c5bf240616db3df97d">XVprocSs::LboxPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a62f9ab872ac328e7e5ecbccafe65a7e6">XVprocSs::VcrsmplrInPtr</a>, <a class="el" href="struct_x_vproc_ss.html#add2fbe91511d24e070039c1cba33f7c1">XVprocSs::VcrsmplrOutPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a7110cce03d4d2ff4c4972bfe460eee42">XVprocSs::VdmaPtr</a>, <a class="el" href="struct_x_vproc_ss.html#ad8ca19d5dd2ac25e58be55ff8ba2b3fa">XVprocSs::VscalerPtr</a>, <a class="el" href="group__vprocss.html#gabeba7bd429b2f9f668ddf656a0c7ba3f">XVPROCSS_EDAT_SUCCESS</a>, <a class="el" href="group__vprocss.html#ggadda80cee8527fb0dac1e98e657f12cd9a7f440bf73b91e8287f25032ff2b63020">XVPROCSS_EVT_STOP_VPSS</a>, and <a class="el" href="xvprocss_8h.html#a477ddfa18fa5fda8658ec72fb29a2d25">XVprocSs_LogWrite()</a>.</p>

</div>
</div>
<a id="a4bdc6a00278cb1c847429d7498f8505e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bdc6a00278cb1c847429d7498f8505e">&#9670;&nbsp;</a></span>XVprocSs_UpdateZoomPipWindow()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XVprocSs_UpdateZoomPipWindow </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_vproc_ss.html">XVprocSs</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function updates the Pip/Zoom window currently on screen in-place. </p>
<p>This implies the video is not blanked and the new coordinates will update instantly as the function executes</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the Subsystem instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function must be called only after the respective mode (PIP/Zoom) has been enabled and user wants to move window to a new location This function is not applicable in Subsystem Stream Mode Configuration </dd></dl>

<p class="reference">References <a class="el" href="struct_x_vproc_ss.html#ad05c179ff8b000570b16a8ac39f885d7">XVprocSs::CtxtData</a>, <a class="el" href="struct_x_vproc_ss.html#a7cc8183d534f77c5bf240616db3df97d">XVprocSs::LboxPtr</a>, <a class="el" href="struct_x_vproc_ss.html#a1fce9dc484558616980012f4a77764ee">XVprocSs::VidOut</a>, <a class="el" href="struct_x_vproc_ss___context_data.html#a79a5e7387a84068901a397e67c494e4d">XVprocSs_ContextData::WrWindow</a>, <a class="el" href="group__vprocss.html#gabeba7bd429b2f9f668ddf656a0c7ba3f">XVPROCSS_EDAT_SUCCESS</a>, <a class="el" href="group__vprocss.html#ggadda80cee8527fb0dac1e98e657f12cd9af2ff6134491d7c3675540e4cec7d2cbb">XVPROCSS_EVT_UPDATE_ZPWIN</a>, <a class="el" href="xvprocss_8h.html#ab0a3f8f3946c8d71bac750de3c62b2c8">XVprocSs_IsConfigModeMax</a>, <a class="el" href="xvprocss_8h.html#a2ce543275b5cd3b7f24c31897aecf5fa">XVprocSs_IsPipModeOn</a>, and <a class="el" href="xvprocss_8h.html#a477ddfa18fa5fda8658ec72fb29a2d25">XVprocSs_LogWrite()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
